快速查看#

在 Scripting 应用中，QuickLook API 提供了一种简单的方法，用于在脚本中预览文本、图片或文件。这是对 iOS QuickLook 功能的封装，允许您快速显示多种内容类型的预览。

每个方法都会返回一个 Promise，该 Promise 会在 QuickLook 视图被关闭时解析，从而使您可以轻松地链式调用操作或处理预览后的逻辑。

API 参考#

QuickLook.previewText(text: string): Promise<void>#

显示文本字符串的预览。

参数#

• text (string)：要在预览中显示的文本内容。
• fullscreen (boolean?): 是否以全屏模式预览。默认为false.

返回值#

• Promise<void>：在预览关闭后解析。

示例#

1await QuickLook.previewText("你好，世界！这是一个 QuickLook 预览示例。")
2console.log("文本预览已关闭")

QuickLook.previewImage(image: UIImage): Promise<void>#

显示图片的预览。

参数#

• image (UIImage)：要在预览中显示的图片。
• fullscreen (boolean?): 是否以全屏模式预览。默认为false.

返回值#

• Promise<void>：在预览关闭后解析。

示例#

1// 假设 `myImage` 是一个 UIImage 实例
2await QuickLook.previewImage(myImage, true)
3console.log("图片预览已关闭")

QuickLook.previewURLs(urls: string[]): Promise<void>#

显示一个或多个文件（位于指定的文件 URL 路径）的预览。

参数#

• urls (string[])：文件 URL 字符串数组。每个字符串应指向一个有效的文件路径或可以通过 QuickLook 预览的远程文件。
• fullscreen (boolean?): 是否以全屏模式预览。默认为false.

返回值#

• Promise<void>：在预览关闭后解析。

示例#

1const fileURLs = [
2  "/path/to/file1.pdf",
3  "/path/to/file2.jpg",
4]
5
6await QuickLook.previewURLs(fileURLs)
7console.log("文件预览已关闭")

使用说明#

• UI 阻塞：这些方法会显示一个模态 QuickLook 视图。在用户关闭预览之前，后续代码（await 之后的部分）将暂停执行。
• 错误处理：使用 try...catch 来处理错误，例如无效的文件路径或不支持的内容类型。
• 支持的文件类型：支持的文件类型取决于 iOS 的 QuickLook 功能，包括常见的文件类型，例如 PDF、图片、文本文件等。

示例使用场景#

按顺序预览文本、图片和文件#

1// 预览文本
2await QuickLook.previewText("QuickLook 预览示例")
3
4// 预览图片
5const myImage = UIImage.fromFile("/path/to/image.png")
6await QuickLook.previewImage(myImage)
7
8// 预览文件
9const fileURLs = [
10  "/path/to/file1.pdf",
11  "/path/to/file2.jpg",
12]
13await QuickLook.previewURLs(fileURLs)
14
15console.log("所有预览已完成")

通过这个 API，您可以将 QuickLook 预览无缝集成到脚本中，以最小的努力提升用户体验。